home *** CD-ROM | disk | FTP | other *** search
/ STraTOS 1997 April & May / STraTOS 1 - 1997 April & May.iso / CD01 / INTERNET / BROWSERS / FINGER12 / FINGER.DOC next >
Encoding:
Text File  |  1996-11-06  |  12.8 KB  |  353 lines
  1. Finger
  2. Version 1.22
  3. Coded by Lonny Pursell
  4. (C)1996 by Lonny Pursell and ENCOM
  5. All rights reserved.
  6.  
  7. Date: June 2, 1996
  8.  
  9. ** Documentation **
  10.  
  11. See 'Support' for contacts, credits, and future additions.
  12. See 'Revision History' for a complete list of changes.
  13.  
  14.  
  15. Introduction
  16. ------------
  17. What is Finger?  It's a client program designed to work with the
  18. STiK internet software.  It allows you to check e-mail addresses,
  19. get more detailed information on an account, check your own
  20. account for waiting e-mail, search for other users, and more.
  21.  
  22.  
  23. Disclaimer
  24. ----------
  25. Use this software completely at your own risk.
  26. That pretty much says it all.  8^)
  27.  
  28.  
  29. Program Requirements
  30. --------------------
  31. STiK should be loaded and enabled and on-line
  32. at least a resolution greater than st low
  33. some free disk space on your system
  34.  
  35.  
  36. Installation
  37. ------------
  38. Place FINGER.PRG and FINGER.RSC anywhere you like as it doesn't
  39. matter what drive you execute it form.  FINGER.INF will be
  40. created by the program.  The drive you select should have some
  41. free space on it.
  42.  
  43.  
  44. Program Setup
  45. -------------
  46. Click on the 'Config' button.
  47.  
  48. The finger line will be used as the default when the program
  49. is first launched.
  50.  
  51. The server line should be set to your DNS (dynamic name server),
  52. this would be the same as your 'NAMESERVER=' in the STiK config
  53. file.
  54.  
  55. Click on the 'Save' button.
  56.  
  57. Due to the way in which the finger protocol works there is no way
  58. to predict how much data will be received from the server.  To
  59. get around this the data is dumped to disk into a temporary file
  60. called FINGER.DAT and read back in for display.  The drive the
  61. finger program resides on should have some free disk space.  The
  62. temporary file FINGER.DAT is deleted after being read back in.
  63.  
  64.  
  65. Main Controls
  66. -------------
  67. Main window:
  68.  
  69. Buttons:
  70.   Info    credits
  71.   Config  set and save program configuration to disk
  72.   Output  send finger data to disk or printer (ASCII output)
  73.   Finger  opens the finger dialog
  74.   Exit    exit the program
  75.  
  76. Arrows:
  77.   use the arrows to scroll through the finger data that is returned
  78.   double-click the up arrow to jump to the top 
  79.   double-click the down arrow to jump to the bottom
  80.  
  81. Config window:
  82.  
  83. Input:
  84.   Finger  default finger at program start up
  85.   Server  your DNS server name goes here
  86.   Holist  hotlist entries
  87.  
  88. Buttons:
  89.   Cancel  exit without saving config
  90.   Save    save configuration to disk
  91.  
  92. Finger window:
  93.  
  94. Input:
  95.   Finger   e-mail address or name to query server for
  96.   Hotlist  hotlist entries (double click to query the server)
  97.  
  98. Buttons:
  99.   Finger  start the server query
  100.   Cancel  abort server query
  101.  
  102. Misc controls:
  103.   ESCape key: Aborts the server query.
  104.   ALTernate key: Enter debug mode at program startup.
  105.  
  106.  
  107. Problems and Errors
  108. -------------------
  109. How to use the debug mode.  
  110.  
  111. When in debug mode a file called DEBUG.TXT will be created in the
  112. default directory where the program resides.  When debug mode is
  113. active the temporary file called FINGER.DAT will not be deleted
  114. after being read back in.
  115.  
  116. If you are having a problem you can duplicate, simply exit the
  117. program, rerun the program while holding down the alternate key.
  118. When in debug mode the title at the top of the main dialog will
  119. indicate you are in debug mode.  Now reproduce the error and exit
  120. the program.  Send the DEBUG.TXT file and the FINGER.DAT file to
  121. me for inspection.  It's very important that you archive these
  122. files and then uuencode them before you send them to me.  I need
  123. to see them intact as they were when your system created them.
  124. Mailing them any other way will do me no good since mailers and
  125. such will reformat them and/or add cr/lf or tabs where they may
  126. have been missing before.
  127.  
  128. It's also possible your server has no finger daemon and in that
  129. case you may get an error message or absolutely nothing from the
  130. server.  If this happens you should contact your internet provider
  131. and find out if they support the feature before assuming the
  132. worst.
  133.  
  134. If you finger an address and you get an error message in the
  135. scroll area this is not an error that I need to know about.
  136. In fact it's working fine and the error was generated by the
  137. server and sent back to you.  This means you are definately
  138. communicating with the server only your input was wrong.
  139.  
  140. The debug mode is for serious errors like crashes, out of memory,
  141. lockups, and those sorta things.
  142.  
  143.  
  144. Example Finger Commands
  145. -----------------------
  146. I'll use my own account as an example.  The single qoutes should
  147. _not_ be typed as they are included only to highlight the actual
  148. data that should be entered.
  149.  
  150. Please note that you cannot finger your own account like this
  151. 'lp@mail' or 'lp@post' as this program does not attempt to
  152. resolve the host name portion of the finger address into it's
  153. full name.  I can finger my own account with my user name
  154. 'lprusell' or my full e-mail address 'lpursell@mail.bright.net'.
  155.  
  156. To finger my own account:
  157.  
  158. 'lpursell'  my user name, this works the best
  159. 'Lonny'     this works, but you might get a long list of Lonny's
  160.  
  161. ' @brutus.bright.net'   returns the users on the consoles
  162. (note the leading space is required)
  163.  
  164. ''  a blank line will also return the users on the consoles
  165.  
  166. If you are looking for 'Steve' you can simply enter 'Steve' and
  167. get a complete list all users with the name 'Steve'.
  168.  
  169. Keep in mind some servers return very little information while
  170. others return a lot.
  171.  
  172.  
  173. Support
  174. -------
  175. This program is FreeWare.  There is no fee required to use this
  176. software nor is anything disabled.  This is a fully functional
  177. program.  However, donations will be accepted.
  178.  
  179. Contact:
  180.  
  181.   Lonny L Pursell
  182.   101 1/2 S High Street  Apt C
  183.   Columbus Grove  OH  45830
  184.   USA
  185.  
  186.  
  187.   E-Mail: atari@bright.net
  188.      WWW: http://www.bright.net/~atari/
  189.      IRC: lp on channel #Atari
  190.  
  191. When reporting bugs please include _detailed_ information about
  192. your system setup and the files generated by the debug mode.
  193.  
  194. Note: I do not have the time or desire to blindly track what
  195. looks like bugs on non-Atari hardware.  If this program fails
  196. on an emulator I suggest you either don't use this program or
  197. get a real computer.
  198.  
  199.  
  200. Future Additions
  201. ----------------
  202. The main window and info window work as they should however the
  203. configuration and finger windows are still modal.  This is due
  204. to the input lines and I have not worked out the code to handle these
  205. properly in a window.  Having the main part of the program in a window
  206. was the important part and that I have done.
  207.  
  208.  
  209. Credits
  210. -------
  211. I'd like to thank:
  212.   Nicholas Flintham (aka Flinny) for sending me the STiK dev kit
  213.   Guy Harrison (aka Swampdog) for all his help and suggestions
  214.   All the STiK beta testers  (you know who you are)  ;^)
  215.   Ozzy Osbourne --> Ozzmosis <-- This album R-O-C-K-S !
  216.   Steve Adam for introducing STiK to the world of Atari
  217.   Dan Ackerman for having the nerve to follow in Steve's foot prints
  218.  
  219.  
  220. Revision History
  221. ----------------
  222. [beta .01]
  223. It seemed to work ok on my system.  =)
  224.  
  225. [beta .02]
  226. If the FINGER.INF file is not found the program will fill in the
  227. cache path with the default path when the program was started.
  228. The program will fill in the server setting with the NAMESERVER
  229. tag returned by STiK if loaded and enabled.  If the NAMESERVER
  230. tag is not found then the server setting is left blank.  Likewise
  231. the finger setting will be filled in with the USERNAME tag if
  232. found.
  233.  
  234. The first beta allocated all free ram at startup!  It now only
  235. allocates about 32k for itself.  It dynamically allocates ram as
  236. needed based on how much data it has transfered from the server.
  237. If for some reason you get an out of memory error, you will not
  238. be able to view the results of the finger.
  239.  
  240. Tabs are now properly handled in the display area.  The progam
  241. currently has a fixed tab size of 8 chars.  This may have to be
  242. made configurable.  Do all servers use a tab spacing of 8
  243. characters?  It's fixed at 8 chars until a bug report comes in I
  244. guess.  =)
  245.  
  246. Improved disk error handling when writing to the cache.  No one
  247. reported disk errors however it now handles write-protected and
  248. full disk errors properly.
  249.  
  250. Minor visual changes to the resource file were made.  I removed
  251. the subtitle and moved the server and cache setting to the bottom
  252. of the dialog.  The button spacing was adjusted to allow for the
  253. 3D effects.  This version will display 3D objects if your AES
  254. supports it.
  255.  
  256. [beta .03]
  257. Hopefully fixed a problem with mouse clicks and key presses
  258. bleeding through to the desktop on the Falcon.  Seemed to only
  259. happen with Multi-TOS loaded on my machine.  On machines without
  260. the fancy 3D effects the dialog now looks as it did before.  The
  261. minor problem with the finger input line not displaying
  262. characters properly is fixed.
  263.  
  264. [beta .04]
  265. Due to the way GEM interprets the '@' sign as a null it was not
  266. possible to finger something such as '@bright.net'.  As soon as
  267. you typed the '@' sign as the first character of the finger GEM
  268. grabs hold of it and messes things up.  To get around this I
  269. added a small work around.  To finger '@bright.net' you need to
  270. type ' @bright.net' instead.  Note the leading space.  The
  271. leading space is removed before the finger is sent to the server.
  272. Not the best fix, however it works.
  273.  
  274. [v1.00]
  275. First public release.  Beta .04 with a 1.00 version number.
  276.  
  277. [v1.01]
  278. Moved the configuration settings to a seperate dialog in order to
  279. simplify the main dialog.  Added the default finger setting.
  280. Replaced the silly 'Info' alert boxes with an organized dialog
  281. box.  Made some internal changes that will help me later recode
  282. the interface into a window.  The cache path is now converted to
  283. uppercase.  Updated the doc file too.
  284.  
  285.  
  286. [v1.02]
  287. You will have to reconfigure this version.  The format of the
  288. configuration file has changed and it's now checked to insure
  289. that it's the correct file.  The cache path has been removed
  290. since it seemed to only confuse people.  The temporary file will
  291. now be written to the current directory at the time the program
  292. was executed.  Now you need only make sure that the drive the
  293. program resides on has some free disk space.  I added a debug
  294. routine which is activated by holding down the alternate key
  295. while launching the program.  The debug routine will generate a
  296. file called DEBUG.TXT in the default directory.  The program when
  297. in debug mode dumps internal data to the file which should be
  298. send to me if a serious problem occurs.  When the debug mode is
  299. activated the temporary file FINGER.DAT containing the server
  300. data is not deleted after being read in.  Added a 'Cancel' button
  301. to the config dialog.  Updated the doc file again.
  302.  
  303. [v1.03]
  304. The 'Cancel' button in the Configuration dialog is now 3D and the
  305. border is not left behind when the dialog is removed.  Selecting
  306. 'Cancel' kept the changes you made, but now only selecting 'Save'
  307. keeps them.
  308.  
  309. [v1.04]
  310. The 'out of memory' bug should now be resolved unless you are
  311. indeed out of memory.  For some silly reason I hadn't expected
  312. 'zero' data from the server and that's what was causing this one.
  313. The 'end of file' [error #26] bug should also be fixed as well.
  314. I hadn't expected a missing linefeed at the end of the server
  315. data and it seems some servers do this on a regular basis.  Both
  316. these bugs where found after reviewing the output from my debug
  317. routine, so I guess it was worth the time I put into it.  The
  318. program now compares the screen size (returned from the vdi) to
  319. that of the largest dialog box, if the dialog won't fit in the
  320. given screen size then the program aborts.  This change should
  321. allow the program to run on 'Overscan' equiped machines, that is
  322. as long as the overscan patches into the vdi so it reports the new
  323. screen size.  Now what was I doing before all this happened?  =)
  324.  
  325. [1.10]
  326. The program now runs in a window.  Added the hotlist to the
  327. program which allows 8 entries.  The config file format changed
  328. due to the addition of the hotlist.  The vdi screen size in no
  329. longer checked, instead the size of the desktop work area is
  330. checked.  Added the save to disk option which saves an ASCII text
  331. file.  Updated the docs again.
  332.  
  333. [1.20]
  334. The program now accepts a command line.  If a command line is passed
  335. to the program it opens the window and begins the finger.  If STiK is
  336. not running or initialized for some reason then the command line is
  337. ignored.  Updated and fixed some typos in the doc file.
  338.  
  339. [1.21]
  340. The contents of the command line and environment strings are now
  341. dumped to the debug file.  The command line support only worked on
  342. single-tasking versions of TOS because I failed to support the ARGV
  343. specification.  The command line now supports ARGV and I tested it
  344. with Multi-TOS so I know it works now.  The command line is also
  345. clipped to fit into the editable object too.  Updated the doc file yet
  346. again.
  347.  
  348. [1.22]
  349. Added tcp_close() and tcp_send() calls to the debug routine.
  350. Updated the docs with my new e-mail address.
  351.  
  352. eof
  353.